home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / prview11.zip / PREVIEW.DOC < prev    next >
Text File  |  1992-06-18  |  10KB  |  240 lines
  1. GIF Previewer Ver 1.0
  2.  
  3. The GIF Previewer Door is a door written that allows a user to select up to
  4. 29 GIFs and create one GIF and download that GIF so he/she can examine the
  5. GIFs to see if they really want to download these GIFs.
  6.  
  7. Preview Features:
  8.  
  9.    1. Entry of a logo into the array created
  10.    2. File search and listing capabilities
  11.    3. External transfer protocol support
  12.    4. Custom menus
  13.  
  14. History
  15.  
  16.    Ver 0.1B - Never released, based on GDS
  17.  
  18.    Ver 0.2B - I decided to use GIFDesk instead of GDS as the use of GDS
  19.               required a registered version plus GDS precluded the door
  20.               operating in a multitasking environment such as DesqView.
  21.  
  22.    Ver 0.3B - Corrected error if user supplied an extension when entering a GIF
  23.               extension. Doesn't matter now, door strips any extension and adds
  24.               a GIF extension.
  25.  
  26.               Corrected error for multi-node systems.  Door was using default
  27.               dir for work dir instead of WORK dir.
  28.  
  29.               Due to idiosynchrosy of GIFDESK, added a line in config file to
  30.               enable renaming of file created by GIFDESK.
  31.  
  32.               Added proper error handling so user isn't so confused when door
  33.               dumps him back to PCB.
  34.  
  35.    Ver 0.4B - Never released, minor bug fixes
  36.  
  37.    Ver 0.5B - Never released, minor bug fixes
  38.  
  39.    Ver 0.6B - Major update, added several new features
  40.  
  41.               Added custom menu, dir and welcome screen support.
  42.  
  43.               Added download capability within the door itself.  This made the
  44.               door no longer PCB specific.
  45.  
  46.               Door now supports standard comm ports 1 - 4 on standard
  47.               interrupts.  See operations section for more details.
  48.  
  49.    Ver 0.7B - minor bug fixes
  50.  
  51.    Ver 0.8B - minor bug fixes
  52.  
  53.               Added external protocol support and removed internal protocols
  54.  
  55.               Added file tagging within dir listings and searches
  56.  
  57.    Ver 0.9B - Removed hot keys from menu.
  58.  
  59.               Increased total number of GIFs per array to 29, as the file size
  60.               of the GIF created is only between 80 and 90 kilbytes
  61.  
  62.               Added wild card support when selecting GIFs.
  63.  
  64.               Minor comsmetic fixes.
  65.  
  66. Set Up
  67.  
  68.    1. Create a config file that contains the following information
  69.       1 - Complete path to door.sys file
  70.           (See operations section for file types supported.)
  71.       2 - The name of your BBS
  72.       3 - Sysop's first name
  73.       4 - Sysop's last name
  74.       5 - Complete path to the work directory that Preview will place the
  75.           arrays for download.  This directory must be dedicated to Preview as
  76.           it erased every time the door is run.  This directory is also used as
  77.           a scratch dir for Preview.
  78.       6 - Complete path and file name to Preview main menu
  79.       7 - Complete path and file name to Preview DIR menu
  80.       8 - Complete path and file name to Preview welcome screen
  81.       9 - Name of GIF created by GIFDESK.  Limited to six characters or less.
  82.           As each collage is created, it is named COLLAG1, COLLAG2, ECT...
  83.      10 - The total number of GIF directories that the door will process
  84.      11 - Complete path and file name of first PCB GIF DIR file
  85.      12 - Complete path to GIF directory that is linked to entry 7
  86.      13,14 - Same as 11 and 12
  87.  
  88.       If you have an entry of 4 in line 6 then you must have 8 entries
  89.       following.  Each two lines after line 6 is the board DIR file and it's
  90.       linked directory.  A sample config file is included.
  91.  
  92.    3. Create the file PROT.DAT in the PREVIEW directory.  This file is the list
  93.       of transfer protocols, their corresponding letter in the protocol menu
  94.       displayed to users, the batch file calling the protocol and whether the
  95.       protocol is batch transfer capable.  See the Operations section for the
  96.       exact lay out of this file.
  97.  
  98.    4. Create a file to execute the Preview Door
  99.  
  100.       @ECHO OFF
  101.       CD D:\PCB1\DOORS\PREVIEW
  102.       PREVIEW PREVIEW.CFG
  103.  
  104.    5. Add the Preview Door entry to your doors list file
  105.  
  106.    6. Set the environment variable GIFDESK=FILE.  This is required so GIFDesk
  107.    can opearte under any graphics card/monitor configuration to include a
  108.    monochrome system.  I recommend setting this variable in you AUTOEXEC.BAT
  109.    file.
  110.  
  111. Operation
  112.  
  113.    If a user selects 3 or fewer GIFs then Preview will create a four GIF array
  114.    and if he/she selects between 4 and 8, Preview will create a nine GIF array.
  115.    If the user selects nine or more GIFs, Previewer will create a 30 array GIF.
  116.    When 29 GIFs at 640x480 resolution are selected, the GIF created will be
  117.    about 90K.
  118.  
  119.    If you wish to include a logo in each array generated then create a GIF and
  120.    place it in the Preview work directory.  This GIF must be named A.GIF.  This
  121.    is currently hard coded into Preview so it will be the first GIF in the
  122.    array.  This was done because GIFDESK sorts the GIFs in the array and there
  123.    is currently no way to prevent this.  I recommend a simple logo with two or
  124.    three colors so it will always look relatively the same for each array
  125.    generated.
  126.  
  127.    All custom screens support an ansi version by appending a g to the file name
  128.    specified in the config file.  For example, if you had a menu screen called
  129.    MENU then to send an ansi version of that screen create that screen and name
  130.    it MENUG.
  131.  
  132.    Set up on a multitasking or network environemnt is painless.  Simply create
  133.    a config file with a different work directory.  The work dir must be
  134.    different for each node of operation.
  135.  
  136.    THE PROT.DAT file consists of four entries per line.  The first entry is the
  137.    letter selecting the protocol, the second entry is the actual batch file
  138.    calling the external protocol, the third entry is the description of the
  139.    protocol displayed in the protocol menu and the fourth entry is whether or
  140.    not the protocol is batch capable.  The PROT.DAT file can contain up to 15
  141.    separate protocols.  A sample file is included along with the calling batch
  142.    files.  Four variables are passed to the batch file: %1 is the active comm
  143.    port, %2 is the callers connect speed, %3 is the file name and %4 is the
  144.    computer to modem connect speed.  Sample batch files utilizing DSZ are
  145.    provided for XModem, XModem-1K, YModem(g) and ZModem
  146.  
  147.    The door currently supports six different door file types:
  148.  
  149.       PCBOARD.SYS  - PCBoard 14.5a
  150.       CALLINFO.BBS - Wildcat system prior to ver 3
  151.       USERINFO.BBS - Wildcat systems ver 3.x
  152.       DOOR.SYS     - For systems that support DOOR.SYS
  153.       DORINFOx.DEF - QBBS/RBBS/RA (change x to reflect node number)
  154.       SFDOORS.DAT  - Spitfire systems
  155.  
  156.     The door supports standard comm ports 1 - 4
  157.  
  158.       Port 3 on 3E8/IRQ4 and Port 4 on 2E8/IRQ3
  159.  
  160.       Non-standard comm port interrupts are also supported.  To utilize IRQ 5
  161.       your command line to call the door should look like this:
  162.  
  163.       PREVIEW PREVIEW.CFG /5
  164.  
  165.       If your using DSZ/GSZ to support the file transfers then your batch file
  166.       to call DSZ using COM 3 on address 3E8 using interrupt 5 should look
  167.       something like this:
  168.  
  169.       DSZ ha bo portx 3E8,5 est 0 %2 sz %3.
  170.  
  171.       Batch files for standard com ports are provided.  If you use non-standard
  172.       IRQs then I suggest reading the docs that came with your protocol.
  173.  
  174.    The following files must be in your DOS path, GIFDESK.EXE and the batch files
  175.    that call each seperate transfer protocol.
  176.  
  177.    Standard DOS wild cards are supported when selecting GIFs for an array.
  178.  
  179.    If you have registered and obtained your key then place the key in the
  180.    PREVIEW directory.
  181.  
  182. Warranty
  183.  
  184.     This product is provided "as is" without warranty of any kind. The entire
  185.     risk as to the results and  performance of the program is assumed by you.
  186.     Futhermore, the  author does  not warrant, guarantee, or  make any  other
  187.     representations regarding  the use of,  or the  results of the use of the
  188.     program,  and you  rely on the  program and  results  solely at  your own
  189.     risk.  The author  cannot and  will not accept  responsibility for system
  190.     damage, loss of profit, or any other special, consequential or incidental
  191.     damages  resulting  from  the  use  or  inability  to  use this  product.
  192.  
  193. Copyright
  194.  
  195.     GIF Previewer Copyright (c) 1992 by  Chris Gifford  is being distributed as
  196.     Shareware. Under this concept you may use the  SHAREWARE  (unregistered)
  197.     version for a reasonable period of  time for evaluation  after which you
  198.     must either register your copy or discontinue  usage.  This time period is
  199.     set for 60 days.
  200.  
  201. Registration:
  202.  
  203.     Registration gets you support via tha Antares Sector BBS (813) 931-7537.
  204.     A registration fee of $20 is required.  Please send all registrations to:
  205.  
  206.       Chris Gifford
  207.       282 Mindella Way
  208.       Layton, UT  84041
  209.  
  210.     Please include exactly how you want your name to appear when the door first
  211.     opens.  You are limited to 35 characters or less.  Please include your BBS
  212.     number so I can upload the latest version of PREVIEW and the key to remove
  213.     to opening delay.
  214.  
  215. Distribution
  216.  
  217.    You  are encouraged to distribute PREVIEW provided that all files
  218.    contained in the archive are distributed in their original and
  219.    unmodified state.
  220.  
  221.    If you wish to be a beta tester then leave me a comment on the Antares
  222.    Sector BBS.  Being a Beta Tester gets you a free version of the non-beta
  223.    release of Preview.  To be a beta tester, I'll need the name and number of
  224.    the BBS that Preview will be operating on and feed back atleast once a week,
  225.    even if it's to say that no errors have been encountered.
  226.  
  227. Credits
  228.  
  229.    Preview Ver 0.9B was developed under a shareware version of DFRAME.  A doors
  230.    development kit for MS Basic 7.X PDS and is copyrighted by Ted Freeman of
  231.    MicroNet BBS (615) 626-1620.
  232.  
  233.    All tradmarks are copyrighted by their respective owners.
  234.  
  235.    Credit where credit is due:
  236.  
  237.    Many thanks go to Robert Perreault of PC-Link BBS.  With out his help and
  238.    input PREVIEW would not have come along as fast as it has.
  239.  
  240.